[MDL-85621] Add first version of Badges API #1399
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sarjona
added
the
blocked-by-tracker
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces the initial documentation for the Badges API, adding an entry in the development update and a full API reference page.
- Adds a “Badges API reorganisation” section to docs/devupdate.md, summarizing key changes.
- Creates docs/apis/subsystems/badges/index.md with API overview, Open Badges history, JSON schema examples, and exporter folder layout.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/devupdate.md | Added Badges API reorganisation note with change highlights. |
| docs/apis/subsystems/badges/index.md | New Badges API reference page with background and usage details. |
Comments suppressed due to low confidence (4)
docs/devupdate.md:23
- The
issueNumberattribute appears to reference MDL-82147, but this PR tracks MDL-85621. Please correct the issue number for consistency.
<Since version="5.1" issueNumber="MDL-82147" />
docs/devupdate.md:21
- [nitpick] Spelling is inconsistent: the heading uses British ‘reorganisation’ while the bullet uses American ‘Reorganizing’. Choose one variant for consistency.
## Badges API reorganisation
docs/devupdate.md:29
- [nitpick] Consider clarifying this bullet—e.g. "Refactor JSON exporters to support multiple Open Badges schema versions"—to more accurately describe the change.
- Re-implementing JSON files to support multiple Open Badges versions (MDL-85621). This will allow for seamless integration with different schema requirements.
docs/apis/subsystems/badges/index.md:13
- [nitpick] The bold markup closes before the closing parenthesis. To include the entire phrase in bold, move the closing
**to after the).
The **Open Badges** standard, designed to recognize and verify learning achievements, has evolved significantly since its beginning. The **Mozilla Foundation** launched the initial version in 2012 with **Open Badges 1.0** and its "Backpack" platform. Over time, the standard matured, with **Open Badges 2.0** officially released by the **IMS Global Learning Consortium (now 1EdTech**) on April 12, 2018.
c2c3b4e to
fd8740c
Compare
sarjona
removed
the
blocked-by-tracker
sarjona
force-pushed
the
badgesjson
branch
2 times, most recently
from
485178f to
6e6a20b
Compare
Collaborator
|
All good ! Ready for merge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Apart from creating the Badges API page, this pull request also documents the main changes implemented in https://moodle.atlassian.net/browse/MDL-85621 and includes a note in the devupdate for easier discovery.